/*
 * Copyright 2004 original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.jbfilter.bean.fcomps.single;

import java.util.regex.Pattern;
import java.util.regex.PatternSyntaxException;

import org.jbfilter.bean.PropertyAccessibleBean;
import org.jbfilter.core.fcomps.single.RegexFilterComponent;

/**
 * The library's variant of {@link RegexFilterComponent}. The 
 * @author Marcus Adrian
 * @param <E> the type of the beans to filter
 * @see RegexFilterComponentBean
 */
public interface RegexFilterComponentBean<E>
	extends
		RegexFilterComponent<E>,
		SingleFilterComponentBean<E, String>,
		PropertyAccessibleBean<E, String> {
	
	/**
	 * To retrieve the exception when the set value (the pattern is set by {@link RegexFilterComponent#setValue(Object)})
	 * is an incorrect regular expression.
	 * @return the exception for wrong regular exceptions, otherwise {@code null}
	 */
	PatternSyntaxException getPatternSyntaxException();
	/**
	 * The pattern object resulting from the {@link #setValue(String)} setting
	 * (or direct setting through {@link #setPattern(Pattern)}).
	 * @return
	 */
	Pattern getPattern();
	/**
	 * Optionally the pattern can be set directly.
	 * @return
	 */
	void setPattern(Pattern pattern);

}
